Skip to content

Improve Documentation Routing & Fix All Internal Broken Links #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

RanaMoizHaider
Copy link
Contributor

This PR enhances the documentation routing system to eliminate the need for explicitly including the platform (mobile or desktop) and version in internal docs URLs.

With this change:

  • Internal links like /docs/getting-started/configuration are now automatically resolved to the correct platform and version based on the current documentation context.

  • Manual addition of version or platform segments in internal link URLs is no longer necessary unless you specifically need to point to a different version or platform.

  • All previously broken internal documentation links are fixed and should now work correctly.

  • This improvement streamlines maintenance, reduces errors, and makes writing and navigating documentation easier for contributors and users.

Refactored documentation routes to use named route and better handle platform and version detection from referer. The redirect now supports both platform and version, improving navigation consistency for users switching between documentation pages.
Corrected internal links in security, installation, and quick-start docs to point to updated paths outside the mobile/1 subdirectory for consistency and accuracy.
Corrected internal links in child-processes and status documentation to remove versioned paths, ensuring consistency and preventing broken links.
@RanaMoizHaider
Copy link
Contributor Author

Currently almost every internal documentation link in desktop documentation takes to https://nativephp.com/docs/mobile/1/getting-started/introduction. Only a few were updated to have /desktop/1/ within them to route properly. Removed them too as the new structure dosen't need you to specify it until you want to route to other platform documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant